Skip to content

docs(microcms-api-schema-schema): README に使い方を追加 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
amotarao merged 5 commits into from
Jan 7, 2026
Merged

docs(microcms-api-schema-schema): README に使い方を追加 #7

amotarao merged 5 commits into from
Jan 7, 2026

Conversation

@amotarao
Copy link
Member

@amotarao amotarao commented Jan 7, 2026

Summary

  • JSON Schema としての使い方を追加（$schema を使った例）
  • サポートされるフィールドタイプの一覧表を追加
  • インストールコマンドを npm/pnpm 両方記載、devDependencies として追加

Test plan

  • README の表示を確認

🤖 Generated with Claude Code

amotarao and others added 4 commits January 8, 2026 00:28
@amotarao @claude
docs(schema): add usage section to README
ea37238 
Add JSON Schema usage example and supported field types table
to help users understand how to use the package.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@amotarao @claude
docs(schema): fix field type descriptions to match source code
68f43f6 
Update field type descriptions based on comments in schema.ts

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@amotarao @claude
docs(schema): add npm command and -D flag for install
29931c4 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@amotarao @claude
docs(schema): fix npm command from add to install
8de363f 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@amotarao amotarao changed the title docs(schema): add usage section to README docs(schema): README に使い方を追加 Jan 7, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 7, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

@plainbrew/microcms-api-schema-schemaパッケージのREADMEを拡張し、インストール例をスコープ付きパッケージ形式に更新。使用例（JSON Schema）の詳細と「サポートされるフィールドタイプ」表を追加。加えて、package.jsonのバージョンを0.0.1-alpha.0から0.0.1へ更新。

Changes

Cohort / File(s) Summary
README Documentation Updates
packages/microcms-api-schema-schema/README.md		 インストールコマンドをスコープ付きパッケージに更新（@plainbrew/microcms-api-schema-schema）。「使い方」セクションにJSON Schemaの具体例（apiFieldsやimageSizeValidation含む）を追加。サポートされるフィールドタイプ表と開発/ビルドコマンドを追加・整理。
Package Metadata
packages/microcms-api-schema-schema/package.json		 パッケージのversionを0.0.1-alpha.0から0.0.1へ更新（機能変更なし）。

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 README に春が来たよ
使い方並べて、例もぽん
インストールは楽々ぴょん
フィールドたちも整列だよ
みんなでスキーマ踊ろう 🎋

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed PRタイトルは「docs(microcms-api-schema-schema): README に使い方を追加」で、変更内容の主な目的であるREADMEへの使用方法の追加を正確に反映しており、明確かつ具体的です。
Description check ✅ Passed PR説明は変更内容と関連していて、JSON Schemaの使い方の追加、フィールドタイプ一覧表の追加、インストールコマンドの記載など、実際の変更を正確に反映しています。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8de363f and dc0f15d.

📒 Files selected for processing (1)
  • packages/microcms-api-schema-schema/package.json
🔇 Additional comments (1)
packages/microcms-api-schema-schema/package.json (1)

3-3: 安定版リリースへの移行を確認してください

バージョンを 0.0.1-alpha.0 から 0.0.1 に変更することで、プレリリース版から安定版への移行となります。READMEに使用方法が追加されたことを踏まえると、この変更は妥当に見えますが、パッケージが本番環境での使用に十分な状態であることを確認してください。

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotarao amotarao changed the title docs(schema): README に使い方を追加 docs(microcms-api-schema-schema): README に使い方を追加 Jan 7, 2026
@amotarao amotarao merged commit cf268a3 into main Jan 7, 2026
2 checks passed
@amotarao amotarao deleted the docs/add-schema-usage branch January 7, 2026 15:40
@coderabbitai coderabbitai bot mentioned this pull request Jan 7, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@amotarao